Fix namespacing for Shiny modules #126
Closed
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This commit addresses Issue rstudio#100. The rank-list widget currently does not get updated when used within a Shiny module. Shiny.sendInputMessage(inputID, message) automatically applies namespacing to inputID (the first parameter), however the widget consists of 2 nested HTML-IDs - the rank-list container and the actual list. Shiny.sendInputMessage only applies namespacing to the provided inputID, but not to inputIDs contained inside the message list-object. In `update_rank_list()`, the way that the provided inputID is processed will make it refer to the container's ID. The rank-list input binding's setValue function has been changed to take this into account and now adds any namespace prefix to the nested input ID. To do this, the namespace has been added explicitly to the message list-object in `update_rank_list()`. Also, `as_rank_list_id()` and `as_bucket_list_id()` both now append (instead of prepend) "-rank-list" to enable Shiny module namespacing as suggested in the respective comment in `methods.R`. Changes: - Updated as_rank_list_id() append "-rank-list" to provided ID. - Improve rank-list JS binding to correctly apply namespacing to the input ID within the message object itself Fixes rstudio#100
|
|
Member
|
Thank you for this contribution. We will be using the solution in #127 instead. I appreciate your time and effort. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
This PR fixes the namespacing issue described in #100 where
update_rank_list()fails inside Shiny modules because nested rank-list element IDs are not correctly namespaced.Background
Shiny namespacing applies only to top-level input IDs and does not automatically propagate to nested widget element IDs inside
inputMessages. As a result, rank-list updates were being sent to non-namespaced DOM IDs, and the client-side binding could not locate the correct list container.What this PR changes
as_rank_list_id()is updated to append the module namespace (id) instead of prepending it.setValue()correctly applies the namespace to inputIDs inside the message object.update_rank_list()explicitly stores the namespace of it's session into the message object, so that the shiny binding can apply it.Why this works
With this fix:
session$ns()becomes compatible with sortable’s internal ID patterns.update_rank_list()correctly updates the UI inside modules.Related Issue
Fixes #100